<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>@businessanalytics/customvis-lib</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="index.html" class="title">@businessanalytics/customvis-lib</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="globals.html">Globals</a>
				</li>
			</ul>
			<h1> @businessanalytics/customvis-lib</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<div class="tsd-panel tsd-typography">
				<a href="#summary" id="summary" style="color: inherit; text-decoration: none;">
					<h2>Summary</h2>
				</a>
				<p>Customvis-lib is a library of classes and functions that help you build custom visualizations. The library is shipped as a <code>.tgz</code> file and is included in every visualization you create. When you create a new custom visualization, you will find this file in the root of your visualization folder structure.</p>
				<p>The classes found in customvis-lib can be divided into:</p>
				<style type="text/css">
.group {
    vertical-align: top;
    box-shadow: none;
    background-color: #fafcfe;
}
.group h3 {
    margin: 0.3em 0;
}
</style>
				<table width="100%">
					<tr><td width="50%" class="group">
							<a href="#legends" id="legends" style="color: inherit; text-decoration: none;">
								<h3>Legends</h3>
							</a>
							<p><em>Needed only in very specific scenarios when you need to modify the default Encodings created by RenderBase.</em></p>
							<ul>
								<li><a href="classes/encoding.html">Encoding</a></li>
								<li><a href="classes/catencoding.html">CatEncoding</a></li>
								<li><a href="classes/contencoding.html">ContEncoding</a></li>
							<li><a href="classes/catencodingentry.html">CatEncodingEntry</a></td><td class="group">
							</li>
							</ul>
							<a href="#data" id="data" style="color: inherit; text-decoration: none;">
								<h3>Data</h3>
							</a>
							<p><em>Classes that represent the data model that will be passed to the visualization.</em></p>
							<ul>
								<li><a href="classes/dataset.html">DataSet</a></li>
								<li><a href="classes/slot.html">Slot</a></li>
								<li><a href="classes/datapoint.html">DataPoint</a></li>
								<li><a href="classes/tuple.html">Tuple</a></li>
								<li><a href="classes/segment.html">Segment</a></li>
							<li><a href="classes/domain.html">Domain</a></td></tr><tr><td class="group">
							</li>
							</ul>
							<a href="#rendering" id="rendering" style="color: inherit; text-decoration: none;">
								<h3>Rendering</h3>
							</a>
							<p><em>Support classes for rendering the visualization. RenderBase is the base class for all custom visualizations.</em></p>
							<ul>
								<li><a href="classes/renderbase.html">RenderBase</a></li>
								<li><a href="classes/renderreason.html">RenderReason</a></li>
								<li><a href="classes/metainfo.html">MetaInfo</a></li>
								<li><a href="classes/updateinfo.html">UpdateInfo</a></li>
							<li><a href="enums/lengthunit.html#point">Point</a></td><td class="group">
							</li>
							</ul>
							<a href="#properties-amp-palettes" id="properties-amp-palettes" style="color: inherit; text-decoration: none;">
								<h3>Properties &amp; palettes</h3>
							</a>
							<p><em>Properties and palettes allow users to customize the looks and behaviour of a visualization.</em></p>
							<ul>
								<li><a href="classes/properties.html">Properties</a></li>
								<li><a href="classes/catpalette.html">CatPalette</a></li>
								<li><a href="classes/contpalette.html">ContPalette</a></li>
								<li><a href="classes/colorstop.html">ColorStop</a></li>
								<li><a href="classes/colorstops.html">ColorStops</a></li>
				<li><a href="classes/color.html">Color</a>, <a href="classes/font.html">Font</a>, <a href="classes/length.html">Length</a></td></tr></table>
				</li>
				</ul>
			</div>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-enum">
						<a href="enums/fontstyle.html" class="tsd-kind-icon">Font<wbr>Style</a>
					</li>
					<li class=" tsd-kind-enum">
						<a href="enums/fontweight.html" class="tsd-kind-icon">Font<wbr>Weight</a>
					</li>
					<li class=" tsd-kind-enum">
						<a href="enums/formattype.html" class="tsd-kind-icon">Format<wbr>Type</a>
					</li>
					<li class=" tsd-kind-enum">
						<a href="enums/lengthunit.html" class="tsd-kind-icon">Length<wbr>Unit</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/catencoding.html" class="tsd-kind-icon">Cat<wbr>Encoding</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/catencodingentry.html" class="tsd-kind-icon">Cat<wbr>Encoding<wbr>Entry</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/catpalette.html" class="tsd-kind-icon">Cat<wbr>Palette</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/color.html" class="tsd-kind-icon">Color</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/colorstop.html" class="tsd-kind-icon">Color<wbr>Stop</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/colorstops.html" class="tsd-kind-icon">Color<wbr>Stops</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/contencoding.html" class="tsd-kind-icon">Cont<wbr>Encoding</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/contpalette.html" class="tsd-kind-icon">Cont<wbr>Palette</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/datapoint.html" class="tsd-kind-icon">Data<wbr>Point</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/dataset.html" class="tsd-kind-icon">Data<wbr>Set</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/domain.html" class="tsd-kind-icon">Domain</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/encoding.html" class="tsd-kind-icon">Encoding</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/font.html" class="tsd-kind-icon">Font</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/length.html" class="tsd-kind-icon">Length</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/metainfo.html" class="tsd-kind-icon">Meta<wbr>Info</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/point.html" class="tsd-kind-icon">Point</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/properties.html" class="tsd-kind-icon">Properties</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/renderbase.html" class="tsd-kind-icon">Render<wbr>Base</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/renderreason.html" class="tsd-kind-icon">Render<wbr>Reason</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/segment.html" class="tsd-kind-icon">Segment</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/slot.html" class="tsd-kind-icon">Slot</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/tuple.html" class="tsd-kind-icon">Tuple</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/updateinfo.html" class="tsd-kind-icon">Update<wbr>Info</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer>
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>